home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / CIncludes / TextCommon.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-08-17  |  19.9 KB  |  457 lines  |  [TEXT/MPS ]
  1. /*
  2.      File:        TextCommon.h
  3.  
  4.      Contains:    TextEncoding-related types and constants, and prototypes for related functions 
  5.  
  6.      Version:    Technology:    Mac OS 8
  7.                  Release:    Universal Interfaces 3.2
  8.  
  9.      Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __TEXTCOMMON__
  18. #define __TEXTCOMMON__
  19.  
  20. #ifndef __MACTYPES__
  21. #include <MacTypes.h>
  22. #endif
  23.  
  24.  
  25.  
  26. #if PRAGMA_ONCE
  27. #pragma once
  28. #endif
  29.  
  30. #ifdef __cplusplus
  31. extern "C" {
  32. #endif
  33.  
  34. #if PRAGMA_IMPORT
  35. #pragma import on
  36. #endif
  37.  
  38. #if PRAGMA_STRUCT_ALIGN
  39.     #pragma options align=mac68k
  40. #elif PRAGMA_STRUCT_PACKPUSH
  41.     #pragma pack(push, 2)
  42. #elif PRAGMA_STRUCT_PACK
  43.     #pragma pack(2)
  44. #endif
  45.  
  46. /* TextEncodingBase type & values */
  47. /* (values 0-32 correspond to the Script Codes defined in Inside Macintosh: Text pages 6-52 and 6-53 */
  48. typedef UInt32                             TextEncodingBase;
  49.  
  50. enum {
  51.                                                                 /* Mac OS encodings*/
  52.     kTextEncodingMacRoman        = 0L,
  53.     kTextEncodingMacJapanese    = 1,
  54.     kTextEncodingMacChineseTrad    = 2,
  55.     kTextEncodingMacKorean        = 3,
  56.     kTextEncodingMacArabic        = 4,
  57.     kTextEncodingMacHebrew        = 5,
  58.     kTextEncodingMacGreek        = 6,
  59.     kTextEncodingMacCyrillic    = 7,
  60.     kTextEncodingMacDevanagari    = 9,
  61.     kTextEncodingMacGurmukhi    = 10,
  62.     kTextEncodingMacGujarati    = 11,
  63.     kTextEncodingMacOriya        = 12,
  64.     kTextEncodingMacBengali        = 13,
  65.     kTextEncodingMacTamil        = 14,
  66.     kTextEncodingMacTelugu        = 15,
  67.     kTextEncodingMacKannada        = 16,
  68.     kTextEncodingMacMalayalam    = 17,
  69.     kTextEncodingMacSinhalese    = 18,
  70.     kTextEncodingMacBurmese        = 19,
  71.     kTextEncodingMacKhmer        = 20,
  72.     kTextEncodingMacThai        = 21,
  73.     kTextEncodingMacLaotian        = 22,
  74.     kTextEncodingMacGeorgian    = 23,
  75.     kTextEncodingMacArmenian    = 24,
  76.     kTextEncodingMacChineseSimp    = 25,
  77.     kTextEncodingMacTibetan        = 26,
  78.     kTextEncodingMacMongolian    = 27,
  79.     kTextEncodingMacEthiopic    = 28,
  80.     kTextEncodingMacCentralEurRoman = 29,
  81.     kTextEncodingMacVietnamese    = 30,
  82.     kTextEncodingMacExtArabic    = 31,                            /* The following use script code 0, smRoman*/
  83.     kTextEncodingMacSymbol        = 33,
  84.     kTextEncodingMacDingbats    = 34,
  85.     kTextEncodingMacTurkish        = 35,
  86.     kTextEncodingMacCroatian    = 36,
  87.     kTextEncodingMacIcelandic    = 37,
  88.     kTextEncodingMacRomanian    = 38,
  89.     kTextEncodingMacCeltic        = 39,
  90.     kTextEncodingMacGaelic        = 40,                            /* Beginning in Mac OS 8.5, the following meta-value is used to indicate Unicode in some parts*/
  91.                                                                 /* of the Mac OS which previously only expected a Mac OS script code. In some of these places,*/
  92.                                                                 /* only 7 bits are available to indicate encoding (script code), so kTextEncodingUnicodeDefault*/
  93.                                                                 /* cannot be used. For example, kTextEncodingMacUnicode can be used to indicate Unicode in the*/
  94.                                                                 /* 7-bit script code field of a Unicode input method's ComponentDescription.componentFlags field;*/
  95.                                                                 /* it can also be used to indicate Unicode in the 16-bit script code field of an AppleEvent's*/
  96.                                                                 /* typeIntlWritingCode text tag.*/
  97.     kTextEncodingMacUnicode        = 0x7E,                            /* Meta-value, Unicode as a Mac encoding*/
  98.                                                                 /* The following use script code 4, smArabic*/
  99.     kTextEncodingMacFarsi        = 0x8C,                            /* Like MacArabic but uses Farsi digits*/
  100.                                                                 /* The following use script code 7, smCyrillic*/
  101.     kTextEncodingMacUkrainian    = 0x98,                            /* The following use script code 28, smEthiopic*/
  102.     kTextEncodingMacInuit        = 0xEC,                            /* The following use script code 32, smUnimplemented*/
  103.     kTextEncodingMacVT100        = 0xFC,                            /* VT100/102 font from Comm Toolbox: Latin-1 repertoire + box drawing etc*/
  104.                                                                 /* Special Mac OS encodings*/
  105.     kTextEncodingMacHFS            = 0xFF,                            /* Meta-value, should never appear in a table.*/
  106.                                                                 /* Unicode & ISO UCS encodings begin at 0x100*/
  107.     kTextEncodingUnicodeDefault    = 0x0100,                        /* Meta-value, should never appear in a table.*/
  108.     kTextEncodingUnicodeV1_1    = 0x0101,
  109.     kTextEncodingISO10646_1993    = 0x0101,                        /* Code points identical to Unicode 1.1*/
  110.     kTextEncodingUnicodeV2_0    = 0x0103,                        /* New location for Korean Hangul*/
  111.     kTextEncodingUnicodeV2_1    = 0x0103,                        /* We treat both Unicode 2.0 and Unicode 2.1 as 2.1*/
  112.                                                                 /* ISO 8-bit and 7-bit encodings begin at 0x200*/
  113.     kTextEncodingISOLatin1        = 0x0201,                        /* ISO 8859-1*/
  114.     kTextEncodingISOLatin2        = 0x0202,                        /* ISO 8859-2*/
  115.     kTextEncodingISOLatin3        = 0x0203,                        /* ISO 8859-3*/
  116.     kTextEncodingISOLatin4        = 0x0204,                        /* ISO 8859-4*/
  117.     kTextEncodingISOLatinCyrillic = 0x0205,                        /* ISO 8859-5*/
  118.     kTextEncodingISOLatinArabic    = 0x0206,                        /* ISO 8859-6, = ASMO 708, =DOS CP 708*/
  119.     kTextEncodingISOLatinGreek    = 0x0207,                        /* ISO 8859-7*/
  120.     kTextEncodingISOLatinHebrew    = 0x0208,                        /* ISO 8859-8*/
  121.     kTextEncodingISOLatin5        = 0x0209,                        /* ISO 8859-9*/
  122.                                                                 /* MS-DOS & Windows encodings begin at 0x400*/
  123.     kTextEncodingDOSLatinUS        = 0x0400,                        /* code page 437*/
  124.     kTextEncodingDOSGreek        = 0x0405,                        /* code page 737 (formerly code page 437G)*/
  125.     kTextEncodingDOSBalticRim    = 0x0406,                        /* code page 775*/
  126.     kTextEncodingDOSLatin1        = 0x0410,                        /* code page 850, "Multilingual"*/
  127.     kTextEncodingDOSGreek1        = 0x0411,                        /* code page 851*/
  128.     kTextEncodingDOSLatin2        = 0x0412,                        /* code page 852, Slavic*/
  129.     kTextEncodingDOSCyrillic    = 0x0413,                        /* code page 855, IBM Cyrillic*/
  130.     kTextEncodingDOSTurkish        = 0x0414,                        /* code page 857, IBM Turkish*/
  131.     kTextEncodingDOSPortuguese    = 0x0415,                        /* code page 860*/
  132.     kTextEncodingDOSIcelandic    = 0x0416,                        /* code page 861*/
  133.     kTextEncodingDOSHebrew        = 0x0417,                        /* code page 862*/
  134.     kTextEncodingDOSCanadianFrench = 0x0418,                    /* code page 863*/
  135.     kTextEncodingDOSArabic        = 0x0419,                        /* code page 864*/
  136.     kTextEncodingDOSNordic        = 0x041A,                        /* code page 865*/
  137.     kTextEncodingDOSRussian        = 0x041B,                        /* code page 866*/
  138.     kTextEncodingDOSGreek2        = 0x041C,                        /* code page 869, IBM Modern Greek*/
  139.     kTextEncodingDOSThai        = 0x041D,                        /* code page 874, also for Windows*/
  140.     kTextEncodingDOSJapanese    = 0x0420,                        /* code page 932, also for Windows; Shift-JIS with additions*/
  141.     kTextEncodingDOSChineseSimplif = 0x0421,                    /* code page 936, also for Windows; was EUC-CN, now GBK (EUC-CN extended)*/
  142.     kTextEncodingDOSKorean        = 0x0422,                        /* code page 949, also for Windows; Unified Hangul Code (EUC-KR extended)*/
  143.     kTextEncodingDOSChineseTrad    = 0x0423,                        /* code page 950, also for Windows; Big-5*/
  144.     kTextEncodingWindowsLatin1    = 0x0500,                        /* code page 1252*/
  145.     kTextEncodingWindowsANSI    = 0x0500,                        /* code page 1252 (alternate name)*/
  146.     kTextEncodingWindowsLatin2    = 0x0501,                        /* code page 1250, Central Europe*/
  147.     kTextEncodingWindowsCyrillic = 0x0502,                        /* code page 1251, Slavic Cyrillic*/
  148.     kTextEncodingWindowsGreek    = 0x0503,                        /* code page 1253*/
  149.     kTextEncodingWindowsLatin5    = 0x0504,                        /* code page 1254, Turkish*/
  150.     kTextEncodingWindowsHebrew    = 0x0505,                        /* code page 1255*/
  151.     kTextEncodingWindowsArabic    = 0x0506,                        /* code page 1256*/
  152.     kTextEncodingWindowsBalticRim = 0x0507,                        /* code page 1257*/
  153.     kTextEncodingWindowsVietnamese = 0x0508,                    /* code page 1258*/
  154.     kTextEncodingWindowsKoreanJohab = 0x0510,                    /* code page 1361, for Windows NT*/
  155.                                                                 /* Various national standards begin at 0x600*/
  156.     kTextEncodingUS_ASCII        = 0x0600,
  157.     kTextEncodingJIS_X0201_76    = 0x0620,                        /* JIS Roman and 1-byte katakana (halfwidth)*/
  158.     kTextEncodingJIS_X0208_83    = 0x0621,
  159.     kTextEncodingJIS_X0208_90    = 0x0622,
  160.     kTextEncodingJIS_X0212_90    = 0x0623,
  161.     kTextEncodingJIS_C6226_78    = 0x0624,
  162.     kTextEncodingGB_2312_80        = 0x0630,
  163.     kTextEncodingGBK_95            = 0x0631,                        /* annex to GB 13000-93; for Windows 95; EUC-CN extended*/
  164.     kTextEncodingKSC_5601_87    = 0x0640,                        /* same as KSC 5601-92 without Johab annex*/
  165.     kTextEncodingKSC_5601_92_Johab = 0x0641,                    /* KSC 5601-92 Johab annex*/
  166.     kTextEncodingCNS_11643_92_P1 = 0x0651,                        /* CNS 11643-1992 plane 1*/
  167.     kTextEncodingCNS_11643_92_P2 = 0x0652,                        /* CNS 11643-1992 plane 2*/
  168.     kTextEncodingCNS_11643_92_P3 = 0x0653,                        /* CNS 11643-1992 plane 3 (was plane 14 in 1986 version)*/
  169.                                                                 /* ISO 2022 collections begin at 0x800*/
  170.     kTextEncodingISO_2022_JP    = 0x0820,
  171.     kTextEncodingISO_2022_JP_2    = 0x0821,
  172.     kTextEncodingISO_2022_CN    = 0x0830,
  173.     kTextEncodingISO_2022_CN_EXT = 0x0831,
  174.     kTextEncodingISO_2022_KR    = 0x0840,                        /* EUC collections begin at 0x900*/
  175.     kTextEncodingEUC_JP            = 0x0920,                        /* ISO 646, 1-byte katakana, JIS 208, JIS 212*/
  176.     kTextEncodingEUC_CN            = 0x0930,                        /* ISO 646, GB 2312-80*/
  177.     kTextEncodingEUC_TW            = 0x0931,                        /* ISO 646, CNS 11643-1992 Planes 1-16*/
  178.     kTextEncodingEUC_KR            = 0x0940,                        /* ISO 646, KS C 5601-1987*/
  179.                                                                 /* Misc standards begin at 0xA00*/
  180.     kTextEncodingShiftJIS        = 0x0A01,                        /* plain Shift-JIS*/
  181.     kTextEncodingKOI8_R            = 0x0A02,                        /* Russian internet standard*/
  182.     kTextEncodingBig5            = 0x0A03,                        /* Big-5 (has variants)*/
  183.     kTextEncodingMacRomanLatin1    = 0x0A04,                        /* Mac OS Roman permuted to align with ISO Latin-1*/
  184.     kTextEncodingHZ_GB_2312        = 0x0A05,                        /* HZ (RFC 1842, for Chinese mail & news)*/
  185.                                                                 /* Other platform encodings*/
  186.     kTextEncodingNextStepLatin    = 0x0B01,                        /* NextStep encoding*/
  187.                                                                 /* EBCDIC & IBM host encodings begin at 0xC00*/
  188.     kTextEncodingEBCDIC_US        = 0x0C01,                        /* basic EBCDIC-US*/
  189.     kTextEncodingEBCDIC_CP037    = 0x0C02,                        /* code page 037, extended EBCDIC (Latin-1 set) for US,Canada...*/
  190.                                                                 /* Special value*/
  191.     kTextEncodingMultiRun        = 0x0FFF,                        /* Multi-encoding text with external run info*/
  192.                                                                 /* The following are older names for backward compatibility*/
  193.     kTextEncodingMacTradChinese    = 2,
  194.     kTextEncodingMacRSymbol        = 8,
  195.     kTextEncodingMacSimpChinese    = 25,
  196.     kTextEncodingMacGeez        = 28,
  197.     kTextEncodingMacEastEurRoman = 29,
  198.     kTextEncodingMacUninterp    = 32
  199. };
  200.  
  201. /* TextEncodingVariant type & values */
  202. typedef UInt32                             TextEncodingVariant;
  203.  
  204. enum {
  205.                                                                 /* Default TextEncodingVariant, for any TextEncodingBase*/
  206.     kTextEncodingDefaultVariant    = 0,                            /* Variants of kTextEncodingMacRoman                                                        */
  207.     kMacRomanStandardVariant    = 0,                            /* standard for Mac OS 8.5, 0xDB is EURO SIGN*/
  208.     kMacRomanCurrencySignVariant = 1,                            /* earlier Mac OS versions, 0xDB is CURRENCY SIGN*/
  209.                                                                 /* Variants of kTextEncodingMacIcelandic                                                    */
  210.     kMacIcelandicStandardVariant = 0,                            /* 0xBB & 0xBC are fem./masc. ordinal indicators*/
  211.     kMacIcelandicTrueTypeVariant = 1,                            /* 0xBB & 0xBC are fi/fl ligatures*/
  212.                                                                 /* Variants of kTextEncodingMacJapanese*/
  213.     kMacJapaneseStandardVariant    = 0,
  214.     kMacJapaneseStdNoVerticalsVariant = 1,
  215.     kMacJapaneseBasicVariant    = 2,
  216.     kMacJapanesePostScriptScrnVariant = 3,
  217.     kMacJapanesePostScriptPrintVariant = 4,
  218.     kMacJapaneseVertAtKuPlusTenVariant = 5,                        /* Variants of kTextEncodingMacArabic*/
  219.     kMacArabicStandardVariant    = 0,                            /* 0xC0 is 8-spoke asterisk, 0x2A & 0xAA are asterisk (e.g. Cairo)*/
  220.     kMacArabicTrueTypeVariant    = 1,                            /* 0xC0 is asterisk, 0x2A & 0xAA are multiply signs (e.g. Baghdad)*/
  221.     kMacArabicThuluthVariant    = 2,                            /* 0xC0 is Arabic five-point star, 0x2A & 0xAA are multiply signs*/
  222.     kMacArabicAlBayanVariant    = 3,                            /* 8-spoke asterisk, multiply sign, Koranic ligatures & parens*/
  223.                                                                 /* Variants of kTextEncodingMacFarsi*/
  224.     kMacFarsiStandardVariant    = 0,                            /* 0xC0 is 8-spoke asterisk, 0x2A & 0xAA are asterisk (e.g. Tehran)*/
  225.     kMacFarsiTrueTypeVariant    = 1,                            /* asterisk, multiply signs, Koranic ligatures, geometric shapes*/
  226.                                                                 /* Variants of kTextEncodingMacHebrew*/
  227.     kMacHebrewStandardVariant    = 0,
  228.     kMacHebrewFigureSpaceVariant = 1,                            /* Variants of Unicode & ISO 10646 encodings*/
  229.     kUnicodeNoSubset            = 0,
  230.     kUnicodeCanonicalDecompVariant = 2,                            /* canonical decomposition; excludes composed characters*/
  231.                                                                 /* Variants of Big-5 encoding*/
  232.     kBig5_BasicVariant            = 0,
  233.     kBig5_StandardVariant        = 1,                            /* 0xC6A1-0xC7FC: kana, Cyrillic, enclosed numerics*/
  234.     kBig5_ETenVariant            = 2,                            /* adds kana, Cyrillic, radicals, etc with hi bytes C6-C8,F9*/
  235.                                                                 /* Unicode variants not yet supported (and not fully defined)*/
  236.     kUnicodeNoCompatibilityVariant = 1,
  237.     kUnicodeNoComposedVariant    = 3,
  238.     kUnicodeNoCorporateVariant    = 4,                            /* The following are older names for backward compatibility*/
  239.     kJapaneseStandardVariant    = 0,
  240.     kJapaneseStdNoVerticalsVariant = 1,
  241.     kJapaneseBasicVariant        = 2,
  242.     kJapanesePostScriptScrnVariant = 3,
  243.     kJapanesePostScriptPrintVariant = 4,
  244.     kJapaneseVertAtKuPlusTenVariant = 5,                        /* kJapaneseStdNoOneByteKanaVariant = 6,    // replaced by kJapaneseNoOneByteKanaOption*/
  245.                                                                 /* kJapaneseBasicNoOneByteKanaVariant = 7,    // replaced by kJapaneseNoOneByteKanaOption    */
  246.     kHebrewStandardVariant        = 0,
  247.     kHebrewFigureSpaceVariant    = 1,
  248.     kUnicodeMaxDecomposedVariant = 2,                            /* replaced by kUnicodeCanonicalDecompVariant*/
  249.                                                                 /* The following Japanese variant options were never supported and are now deprecated.*/
  250.                                                                 /* In TEC 1.4 and later their functionality is replaced by the Unicode Converter options listed.*/
  251.     kJapaneseNoOneByteKanaOption = 0x20,                        /* replaced by UnicodeConverter option kUnicodeNoHalfwidthCharsBit*/
  252.     kJapaneseUseAsciiBackslashOption = 0x40                        /* replaced by UnicodeConverter option kUnicodeForceASCIIRangeBit*/
  253. };
  254.  
  255. /* TextEncodingFormat type & values */
  256. typedef UInt32                             TextEncodingFormat;
  257.  
  258. enum {
  259.                                                                 /* Default TextEncodingFormat for any TextEncodingBase*/
  260.     kTextEncodingDefaultFormat    = 0,                            /* Formats for Unicode & ISO 10646*/
  261.     kUnicode16BitFormat            = 0,
  262.     kUnicodeUTF7Format            = 1,
  263.     kUnicodeUTF8Format            = 2,
  264.     kUnicode32BitFormat            = 3
  265. };
  266.  
  267. /* TextEncoding type */
  268. typedef UInt32                             TextEncoding;
  269. /* name part selector for GetTextEncodingName*/
  270. typedef UInt32                             TextEncodingNameSelector;
  271.  
  272. enum {
  273.     kTextEncodingFullName        = 0,
  274.     kTextEncodingBaseName        = 1,
  275.     kTextEncodingVariantName    = 2,
  276.     kTextEncodingFormatName        = 3
  277. };
  278.  
  279. /* Types used in conversion */
  280.  
  281. struct TextEncodingRun {
  282.     ByteOffset                         offset;
  283.     TextEncoding                     textEncoding;
  284. };
  285. typedef struct TextEncodingRun            TextEncodingRun;
  286. typedef TextEncodingRun *                TextEncodingRunPtr;
  287.  
  288. typedef const TextEncodingRun *            ConstTextEncodingRunPtr;
  289.  
  290. struct ScriptCodeRun {
  291.     ByteOffset                         offset;
  292.     ScriptCode                         script;
  293. };
  294. typedef struct ScriptCodeRun            ScriptCodeRun;
  295. typedef ScriptCodeRun *                    ScriptCodeRunPtr;
  296.  
  297. typedef const ScriptCodeRun *            ConstScriptCodeRunPtr;
  298. typedef UInt8 *                            TextPtr;
  299. typedef const UInt8 *                    ConstTextPtr;
  300. /* Basic types for Unicode characters and strings: */
  301. typedef UniChar *                        UniCharArrayPtr;
  302. typedef const UniChar *                    ConstUniCharArrayPtr;
  303. /* enums for TextEncoding Conversion routines*/
  304.  
  305. enum {
  306.     kTextScriptDontCare            = -128,
  307.     kTextLanguageDontCare        = -128,
  308.     kTextRegionDontCare            = -128
  309. };
  310.  
  311. /* struct for TECGetInfo*/
  312.  
  313.  
  314. struct TECInfo {
  315.     UInt16                             format;                        /* format code for this struct*/
  316.     UInt16                             tecVersion;                    /* TEC version in BCD, e.g. 0x0121 for 1.2.1*/
  317.     UInt32                             tecTextConverterFeatures;    /* bitmask indicating TEC features/fixes*/
  318.     UInt32                             tecUnicodeConverterFeatures; /* bitmask indicating UnicodeConverter features/fixes*/
  319.     UInt32                             tecTextCommonFeatures;        /* bitmask indicating TextCommon features/fixes*/
  320.     Str31                             tecTextEncodingsFolderName;    /* localized name of Text Encodings folder (pascal string)*/
  321.     Str31                             tecExtensionFileName;        /* localized name of TEC extension (pascal string)*/
  322. };
  323. typedef struct TECInfo                    TECInfo;
  324. typedef TECInfo *                        TECInfoPtr;
  325. typedef TECInfoPtr *                    TECInfoHandle;
  326. /* Value for TECInfo format code*/
  327.  
  328. enum {
  329.     kTECInfoCurrentFormat        = 1                                /* any future formats will just add fields at the end*/
  330. };
  331.  
  332. /*
  333.    Defined feature/fix bits for tecUnicodeConverterFeatures field
  334.    Bit:                                Meaning if set:
  335.    ----                                ---------------
  336.    kTECKeepInfoFixBit                Unicode Converter no longer ignores other control flags if
  337.                                       kUnicodeKeepInfoBit is set. Bug fix in TEC Manager 1.2.1.
  338.    kTECFallbackTextLengthFixBit        Unicode Converter honors the *srcConvLen and *destConvLen
  339.                                       returned by caller-supplied fallback handler for any status it
  340.                                       returns except for kTECUnmappableElementErr (previously it only
  341.                                       honored these values if noErr was returned). Bug fix in TEC
  342.                                       Manager 1.2.1.
  343.    kTECTextRunBitClearFixBit        ConvertFromUnicodeToTextRun & ConvertFromUnicodeToScriptCodeRun
  344.                                       function correctly if the kUnicodeTextRunBit is set (previously
  345.                                       their determination of best target encoding was incorrect). Bug
  346.                                       fix in TEC Manager 1.3.
  347.    kTECTextToUnicodeScanFixBit        ConvertFromTextToUnicode uses an improved scanner and maintains
  348.                                       some resulting state information, which it uses for mapping.
  349.                                       This has several effects:
  350.                                       - Improved mapping of 0x30-0x39 digits in Mac OS Arabic, fewer
  351.                                         direction overrides when mapping Mac OS Arabic & Hebrew, and
  352.                                         improved mapping of certain characters in Indic encodings.
  353.                                       - Malformed input produces kTextMalformedInputErr.
  354.                                       - ConvertFromTextToUnicode accepts and uses the control flags
  355.                                         kUnicodeKeepInfoMask and kUnicodeStringUnterminatedMask.
  356.                                       Bug fix and enhancement in TEC Manager 1.3.
  357.    kTECAddForceASCIIChangesBit        Define new control flag bits kUnicodeForceASCIIRangeBit and
  358.                                       kUnicodeNoHalfwidthCharsBit for use with
  359.                                       ConvertFromTextToUnicode, ConvertFromUnicodeToText, etc.
  360.                                       Enhancement in TEC Manager 1.4.
  361.    kTECPreferredEncodingFixBit        CreateUnicodeToTextRunInfo and related functions fix a problem
  362.                                       that occurred when a preferred encoding was specified that did
  363.                                       not match the System script; the preferred script was not
  364.                                       actually placed first in the ordered list of encodings to use.
  365.                                       Bug fix in TEC Manager 1.4.
  366. */
  367.  
  368.  
  369. enum {
  370.     kTECKeepInfoFixBit            = 0,
  371.     kTECFallbackTextLengthFixBit = 1,
  372.     kTECTextRunBitClearFixBit    = 2,
  373.     kTECTextToUnicodeScanFixBit    = 3,
  374.     kTECAddForceASCIIChangesBit    = 4,
  375.     kTECPreferredEncodingFixBit    = 5
  376. };
  377.  
  378.  
  379. enum {
  380.     kTECKeepInfoFixMask            = 1L << kTECKeepInfoFixBit,
  381.     kTECFallbackTextLengthFixMask = 1L << kTECFallbackTextLengthFixBit,
  382.     kTECTextRunBitClearFixMask    = 1L << kTECTextRunBitClearFixBit,
  383.     kTECTextToUnicodeScanFixMask = 1L << kTECTextToUnicodeScanFixBit,
  384.     kTECAddForceASCIIChangesMask = 1L << kTECAddForceASCIIChangesBit,
  385.     kTECPreferredEncodingFixMask = 1L << kTECPreferredEncodingFixBit
  386. };
  387.  
  388. /* Prototypes for TextEncoding functions*/
  389.  
  390. EXTERN_API( TextEncoding )
  391. CreateTextEncoding                (TextEncodingBase         encodingBase,
  392.                                  TextEncodingVariant     encodingVariant,
  393.                                  TextEncodingFormat     encodingFormat);
  394.  
  395. EXTERN_API( TextEncodingBase )
  396. GetTextEncodingBase                (TextEncoding             encoding);
  397.  
  398. EXTERN_API( TextEncodingVariant )
  399. GetTextEncodingVariant            (TextEncoding             encoding);
  400.  
  401. EXTERN_API( TextEncodingFormat )
  402. GetTextEncodingFormat            (TextEncoding             encoding);
  403.  
  404. EXTERN_API( TextEncoding )
  405. ResolveDefaultTextEncoding        (TextEncoding             encoding);
  406.  
  407. EXTERN_API_C( OSStatus )
  408. GetTextEncodingName                (TextEncoding             iEncoding,
  409.                                  TextEncodingNameSelector  iNamePartSelector,
  410.                                  RegionCode             iPreferredRegion,
  411.                                  TextEncoding             iPreferredEncoding,
  412.                                  ByteCount                 iOutputBufLen,
  413.                                  ByteCount *            oNameLength,
  414.                                  RegionCode *            oActualRegion,
  415.                                  TextEncoding *            oActualEncoding,
  416.                                  TextPtr                 oEncodingName);
  417.  
  418. EXTERN_API( OSStatus )
  419. TECGetInfo                        (TECInfoHandle *        tecInfo);
  420.  
  421.  
  422. EXTERN_API( OSStatus )
  423. UpgradeScriptInfoToTextEncoding    (ScriptCode             iTextScriptID,
  424.                                  LangCode                 iTextLanguageID,
  425.                                  RegionCode             iRegionID,
  426.                                  ConstStr255Param         iTextFontname,
  427.                                  TextEncoding *            oEncoding);
  428.  
  429. EXTERN_API( OSStatus )
  430. RevertTextEncodingToScriptInfo    (TextEncoding             iEncoding,
  431.                                  ScriptCode *            oTextScriptID,
  432.                                  LangCode *                oTextLanguageID,
  433.                                  Str255                 oTextFontname);
  434.  
  435.  
  436.  
  437. #if PRAGMA_STRUCT_ALIGN
  438.     #pragma options align=reset
  439. #elif PRAGMA_STRUCT_PACKPUSH
  440.     #pragma pack(pop)
  441. #elif PRAGMA_STRUCT_PACK
  442.     #pragma pack()
  443. #endif
  444.  
  445. #ifdef PRAGMA_IMPORT_OFF
  446. #pragma import off
  447. #elif PRAGMA_IMPORT
  448. #pragma import reset
  449. #endif
  450.  
  451. #ifdef __cplusplus
  452. }
  453. #endif
  454.  
  455. #endif /* __TEXTCOMMON__ */
  456.  
  457.